Voice Description Records (IM: S)

Chapter 4 - Speech Manager / Speech Manager Reference

Voice Description Records
By calling the GetVoiceDescription function, you can obtain information about a voice in a voice description record. The VoiceDescription data type defines a voice description record.
TYPE VoiceDescription =
RECORD
   length:     LongInt;    {size of record}
   voice:      VoiceSpec;  {voice synthesizer and ID info}
   version:    LongInt;    {version number of voice}
   name:       Str63;      {name of voice}
   comment:    Str255;     {text information about voice}
   gender:     Integer;    {neuter, male, or female}
   age:        Integer;    {approximate age in years}
   script:     Integer;    {script code of text voice can process}
   language:   Integer;    {language code of voice output}
   region:     Integer;    {region code of voice output}
   reserved1:  LongInt;    {always 0--reserved for future use}
   reserved2:  LongInt;    {always 0--reserved for future use}
   reserved3:  LongInt;    {always 0--reserved for future use}
   reserved4:  LongInt;    {always 0--reserved for future use}
END;
Field Description

length
The size of the voice description record, in bytes.
voice
A voice specification record that uniquely identifies the voice.
version
The version number of the voice.
name
The name of the voice, preceded by a length byte. Names must be 63 characters or less.
comment
Additional text information about the voice. The information might indicate how much memory the voice requires. Some synthesizers use this field to store a phrase that can be spoken.
gender
The gender of the individual represented by the voice. The value in this field must be one of the following constants:
               CONST
                  kNeuter     = 0;     {neuter voice}
                  kMale       = 1;     {male voice}
                  kFemale     = 2;     {female voice}
A neuter voice is a voice that is not distinctively male or female.
age
The approximate age in years of the individual represented by the voice.
script
The script code of text that the voice can process.
language
A code that indicates the language of voice output.
region
A code that indicates the region represented by the voice.
reserved1
Reserved.
reserved2
Reserved.
reserved3
Reserved.
reserved4
The four reserved fields are reserved for use by Apple.